Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section on JSON Processing. #1202

Merged
merged 14 commits into from
Aug 9, 2023
Merged

Add section on JSON Processing. #1202

merged 14 commits into from
Aug 9, 2023

Conversation

msporny
Copy link
Member

@msporny msporny commented Jul 14, 2023

This PR attempts to address issue #1201 by documenting how systems process the VCDM using pure JSON processing today.


Preview | Diff

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
@mprorock
Copy link
Contributor

Isn't this more of just a JSON-LD issue than a VC issue? I am not sure I see the value of this PR as it is just saying that JSON-LD is JSON

@mtaimela
Copy link

Thank you @msporny for the clarification PR, I'm in favour of including this PR as is.

@mprorock wrote:

Isn't this more of just a JSON-LD issue than a VC issue? I am not sure I see the value of this PR as it is just saying that JSON-LD is JSON

I would say that it is beneficial for the community that is less technical than average contributor. The clarification is very clearly specifying the duality and the differences of json-ld/json in context of VC/VP, while promoting the use of @context. This "promoted" use of the mandatory @context is against pure json mindset, thus this added section is beneficial for the community.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@decentralgabe decentralgabe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preemptively approving given a small number of tweaks. great addition!

index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@Sakurann Sakurann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR creates more confusion than clarification. One is confusion between payload and securing mechanism processing. Even for the the payload processing, since the base data model is +ld+json, JSON-LD is needed and for example it's misleading to talk about only +json.

index.html Outdated
Comment on lines 3765 to 3972
<li>
When using the JOSE or COSE specifications to secure a
<a>verifiable credential</a> or <a>verifiable presentation</a>.
</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<li>
When using the JOSE or COSE specifications to secure a
<a>verifiable credential</a> or <a>verifiable presentation</a>.
</li>

This is a confusion between payload and securing mechanism processing. this should talk only about the payload which is JSON-LD.

Copy link
Member Author

@msporny msporny Jul 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have accepted @mprorock's suggestions, does that work for you, @Sakurann? If not, please suggest some concrete language.

@awoie
Copy link
Contributor

awoie commented Aug 4, 2023

I filed #1227 to track documenting the value of "processing the core data model as JSON-LD" per the call yesterday.

My change requests on this PR are limited to accepting or dismissing the open suggestions, and once those are resolved, I intend to approve... We should start the related discussions on the value of processing the core data model as JSON-LD on the issue above, and not continue them on this PR... as its getting very difficult to review.

I will no longer block this PR if this is well documented in #1227. If we don't do that, the JSON section just leads to developer confusion.

Copy link
Contributor

@awoie awoie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still doubt the usefulness of this section but I'm not blocking it either.

@awoie awoie self-requested a review August 4, 2023 12:52
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
@OR13
Copy link
Contributor

OR13 commented Aug 4, 2023

Noting conflicts exist, there are new change suggestions, and despite @awoie 's comment here: #1202 (comment)

He is still marked as blocking the PR... as is @Sakurann .

@msporny msporny requested a review from TallTed August 4, 2023 22:11
@brentzundel
Copy link
Member

@awoie since you have indicated you are no longer blocking, I have dismissed your review.

@Sakurann there have been many changes since your request, please re-review.

@brentzundel brentzundel dismissed awoie’s stale review August 7, 2023 21:50

He has indicated that he no longer wishes to block this PR #1202 (review)

Copy link
Member

@brentzundel brentzundel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with others that this information will be much better once accompanied by the changes discussed in issue #1227

Copy link
Contributor

@Sakurann Sakurann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Appreciate the work that has gone into this PR. Not blocking. Looking forward to a similar section on JSON-LD processing.

@iherman
Copy link
Member

iherman commented Aug 9, 2023

The issue was discussed in a meeting on 2023-08-09

  • no resolutions were taken
View the transcript

2.3. Add section on JSON Processing. (pr vc-data-model#1202)

See github pull request vc-data-model#1202.

Manu Sporny: PR 1202, everyone who needs to reviewed has reviewed, need JSON/JSON-LD processing section, conflicts needs to be resolved, plan to merge tomorrow.

@msporny
Copy link
Member Author

msporny commented Aug 9, 2023

Editorial, substantive, multiple reviews, changes requested and made, no remaining objections, merging.

@msporny msporny merged commit 59a9ca0 into main Aug 9, 2023
@msporny msporny deleted the msporny-json-processing branch August 9, 2023 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.